docs: add CONTRIBUTING, SECURITY and .clang-format#913
Open
Aswinmcw wants to merge 1 commit into
Open
Conversation
Aswinmcw
force-pushed
the
docs/add-contributing-security-clang-format
branch
2 times, most recently
from
d80e7e0 to
b0aef0e
Compare
Add contributor-onboarding and security-policy documents, plus a committed clang-format configuration, none of which existed before. - CONTRIBUTING.md: build (incl. 8/10/12-bit + multilib), TestBench and regression testing, coding style, commit-message and PR conventions, guidance for assembly/SIMD contributions, and dual-license terms. - SECURITY.md: private vulnerability-disclosure policy for a codec that parses untrusted input, with reporting channels and scope. - .clang-format: mirrors exactly the style enforced by the Code Quality job in .github/workflows/ci.yml (LLVM base, 4-space, no tabs, 120 col, Allman braces) so local runs match CI. Documentation only; no code or build changes.
Aswinmcw
force-pushed
the
docs/add-contributing-security-clang-format
branch
from
b0aef0e to
a0f98ff
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds three contributor-onboarding / project-hygiene files that did not exist in the repository:
TestBenchand the regression suites, coding style, commit-message and PR conventions, guidance for assembly/SIMD contributions, and dual-licensing terms.libx265, so a coordinated-disclosure channel is valuable; there was none before..github/workflows/ci.ymlgenerates and enforces (LLVM base, 4-space indent, no tabs, 120-col, Allman braces). Committing it lets contributors reproduce the CI style check locally instead of the canonical config living only inside a CI YAML string.Why
The repo had no
CONTRIBUTING,SECURITY, or committed.clang-format. New contributors had to infer the build matrix, test flow, and style from CI internals and history.Notes
.clang-formatis intentionally byte-identical to the CI-generated config, so it introduces no new or conflicting style rules. CI checks only changed lines, so this does not trigger reformatting of existing code.build/generator scripts,source/test/harnesses (TestBench,regression-tests.txt, etc.),doc/uncrustify/codingstyle.cfg,COPYING, and the commit-prefix conventions ingit log.Happy to adjust the security contact address, mailing-list/IRC details, or any wording to match maintainer preference.